<html>
<head>
<title>rsyslog.conf file</title>
</head>
<body>
<a href="rsyslog_conf_global.html">back</a>

<h2>$EscapeControlCharactersOnReceive</h2>
<p><b>Type:</b> global configuration directive</p>
<p><b>Default:</b> on</p>
<p><b>Description:</b></p>
<p>This directive instructs rsyslogd to replace control characters during reception of the message. The intent is to provide a way to stop non-printable messages from entering the syslog system as whole. If this option is turned on, all control-characters are converted to a 3-digit octal number and be prefixed with the $ControlCharacterEscapePrefix character (being '\' by default). For example, if the BEL character (ctrl-g) is included in the message, it would be converted to "\007". To be compatible to sysklogd, this option must be turned on.</p>
<p><b>Warning:</b></p>
<ul>
	<li>turning on this option most probably destroys non-western character sets 
	(like Japanese, Chinese and Korean)</li>
	<li>turning on this option destroys digital signatures if such exists inside 
	the message</li>
	<li>if turned on, the drop-cc, space-cc and escape-cc
	<a href="property_replacer.html">property replacer</a> options do not work 
	as expected because control characters are already removed upon message 
	reception. If you intend to use these property replacer options, you must 
	turn off $EscapeControlCharactersOnReceive.</li>
</ul>
<p><b>Sample:</b></p>
<p><code><b>$EscapeControlCharactersOnReceive on</b></code></p>

<p>[<a href="rsyslog_conf.html">rsyslog.conf overview</a>] [<a href="manual.html">manual 
index</a>] [<a href="http://www.rsyslog.com/">rsyslog site</a>]</p>
<p><font size="2">This documentation is part of the
<a href="http://www.rsyslog.com/">rsyslog</a> project.<br>
Copyright &copy; 2007 by <a href="http://www.gerhards.net/rainer">Rainer Gerhards</a> and
<a href="http://www.adiscon.com/">Adiscon</a>. Released under the GNU GPL 
version 2 or higher.</font></p>
</body>
</html>
